[docs] Templates paths to override in a theme #1411
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for moodledevdocs ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
andrewnicols
requested changes
Aug 19, 2025
| @@ -528,6 +528,22 @@ Templates can be overridden by a theme. | |||
| 1. Copy the `ratingui.mustache` file into the newly created `theme/timtam/templates/mod_wiki` and edit it. | |||
| You should see your changes immediately if theme designer mode is on. Templates are cached just like CSS, so if you are not using theme designer mode you will need to purge all caches to see the latest version of an edited template. If the template you are overriding contains a documentation comment it is recommended to remove it. It will still show the documentation in the template library. | |||
|
|
|||
| ### Paths for overriding templates | |||
There was a problem hiding this comment.
This is all documented above. The following are examples.
| @@ -528,6 +528,22 @@ Templates can be overridden by a theme. | |||
| 1. Copy the `ratingui.mustache` file into the newly created `theme/timtam/templates/mod_wiki` and edit it. | |||
| You should see your changes immediately if theme designer mode is on. Templates are cached just like CSS, so if you are not using theme designer mode you will need to purge all caches to see the latest version of an edited template. If the template you are overriding contains a documentation comment it is recommended to remove it. It will still show the documentation in the template library. | |||
|
|
|||
| ### Paths for overriding templates | |||
|
|
|||
| #### Overriding a template from another plugin | |||
There was a problem hiding this comment.
This is generic to all components, not just plugins.
All use their frankenstyle namespace. For an activity that may be mod_example. For a block, block_example. For a core subsystem it's core_[subsystem], and for core itself, it's just core.
|
|
||
| #### Overriding a template from another plugin | ||
|
|
||
| If you want to override `theme/boost/templates/navbar.mustache`, you should copy and modify it, then **save the new version at** `theme/mytheme/templates/theme_boost/navbar.mustache`. |
There was a problem hiding this comment.
No need to bold the save the new version.
Give an example here. Be clear. Perhaps use a table.
The example of a template from a theme is the most confusing. Mention it last.
Suggested change
| If you want to override `theme/boost/templates/navbar.mustache`, you should copy and modify it, then **save the new version at** `theme/mytheme/templates/theme_boost/navbar.mustache`. | |
| To override a template, you should copy the core template into your theme and then modify the new copy. | |
| Templates are stored in the `templates` directory of your theme. | |
| Within the `theme/[mytheme]/templates` directory the template should be placed in a folder using the frankenstyle name of the component, and then use the same folder and name as the original template within that location. | |
| | Path for original template | Component | Theme override path | | |
| | --- | --- | --- | | |
| | `blocks/myoverview/templates/view-summary.mustache` | `block_myoverview` | `theme/mytheme/templates/block_myoverview/view-summary.mustache` | | |
| | `lib/templates/modal.mustache` | `core` | `theme/mytheme/templates/core/modal.mustache` | | |
| | `theme/boost/templates/navbar.mustache` | `theme_boost` | `theme/mytheme/templates/theme_boost/navbar.mustache` | |
Comment on lines
+536
to
+546
|
|
||
| This principle applies to other plugins. For example, to override the template at `blocks/myoverview/templates/view-summary.mustache` you would place your own at `theme/mytheme/templates/block_myoverview/view-summary.mustache`. | ||
|
|
||
| #### Overriding a template from lib/ | ||
|
|
||
| To override a core template, like, `lib/templates/notification_success.mustache:` you should have your own copy at `theme/mytheme/templates/core/notification_success.mustache`. | ||
|
|
||
| #### Overriding a core subsystem template | ||
|
|
||
| To override a core subsystem template, for example, `message/templates/message_preferences.mustache` place your template at `theme/mytheme/templates/core_message/message_preferences.mustache`. | ||
|
|
There was a problem hiding this comment.
Delete
Suggested change
| This principle applies to other plugins. For example, to override the template at `blocks/myoverview/templates/view-summary.mustache` you would place your own at `theme/mytheme/templates/block_myoverview/view-summary.mustache`. | |
| #### Overriding a template from lib/ | |
| To override a core template, like, `lib/templates/notification_success.mustache:` you should have your own copy at `theme/mytheme/templates/core/notification_success.mustache`. | |
| #### Overriding a core subsystem template | |
| To override a core subsystem template, for example, `message/templates/message_preferences.mustache` place your template at `theme/mytheme/templates/core_message/message_preferences.mustache`. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Information regarding the final paths depending on the template to override